.NET smoke Test Sample #6652
.NET smoke Test Sample #6652
Conversation
Performs functionalities with Key Vault, Identity, Event Hubs and Blob Storage Track 2 SDKs.
There was a problem hiding this comment.
This is a great first cut! This review covers stylistic and a few things dealing with the general logic of the app without diving too far into program design (except the use of static). To that end we'll probably have another review where, after we get the style discussions out of the way, we can dig into the exciting details of Object Oriented design.
The names were changed to match the name convention for environment variables.
A gitignore file was created in the SmokeTest folder, and now all launchSettings.json files are being ignored.
Work based on the reviews from the PR #6652. The public methods are now in PascalCase, the methods does not longer return English strings, instead they return booleans or Exceptions. And Exit Codes handling was implemented.
Class names were changed to match the following pattern: <service>Test. Example: BlobStorage -> BlobStorageTest.
Use of higher order functions to dry up the code.
Drying up the code by using high order functions.
Tests done with Mirosoft.Azure.DocumentDB SDK.
|
@JonathanCrd I'd suggest having a look at #6678 which is doing something very similar to what you are doing and so the pattern might be interesting here as well. |
|
Is the intent here to have a set of samples or to have a set of tests? It looks like it's the later, any reason not to use unit testing framework then? What's the benefit over the live tests? |
The intent is actually to run a set of samples for each of the services in a single application. For now we are just writing samples independently but the goal is to eventually pull in all the samples from the library directory into this single application. |
|
The way it's written right now looks like an attempt to reinvent testing framework. |
|
I wonder if we can build on that idea but avoid ISample all together. Like, have every file be a self-contained copy-pastable app with Program.Main but also have a common runner that is able to run multiple samples. |
I used an interface just to enforce structure; in the context of Event Hubs, I wanted to ensure that every sample had a consistent method to execute which accepted a common set of connection parameters (to avoid ambient context and the need to set environment variables; I wanted to enable the F5 experience in Visual Studio.) I could have made implicit assumptions about the structure to avoid the interface, but preferred to make it explicit in case there were community contributions. With respect to a generic approach that would span client libraries, I'd expect that to be tough without ending up with the need for ambient environment requirements again. In my opinion, having an approachable "it just works" experience for being able to launch the debugger is the more desirable side of that trade off. |
|
I agree it is something to build on and I'm fine making them standalone but we still need a way to aggregate them together. |
I wonder if we can use System.CommandLine (https://github.com/dotnet/command-line-api) inside sample apps themselves making them explicit and directly callable but also easy to aggregate. |
The samples not longer need the "TestBase" class to run.
This text file is not going to be needed any more since the test Blob is being created within the code.
All classes are now static.
* .NET smoke Test Sample Performs functionalities with Key Vault, Identity, Event Hubs and Blob Storage Track 2 SDKs. * Env Variables names changed The names were changed to match the name convention for environment variables. * Update .gitignore * gitignore updated A gitignore file was created in the SmokeTest folder, and now all launchSettings.json files are being ignored. * Exit Codes, PascalCase and refactoring of the static methods. Work based on the reviews from the PR Azure#6652. The public methods are now in PascalCase, the methods does not longer return English strings, instead they return booleans or Exceptions. And Exit Codes handling was implemented. * Class names changed Class names were changed to match the following pattern: <service>Test. Example: BlobStorage -> BlobStorageTest. * Comments XML comments were added and some unnecesary comments were deleted. * Higher order functions Use of higher order functions to dry up the code. * Test classes refactured Drying up the code by using high order functions. * Create CosmosDBTest.cs * Cosmos DB implementation Tests done with Mirosoft.Azure.DocumentDB SDK. * Update CosmosDBTest.cs * Update CosmosDBTest.cs * Unnecessary blank lines removed * ExecuteTest typo * Base class deleted The samples not longer need the "TestBase" class to run. * BlobTestSource.tst deleted This text file is not going to be needed any more since the test Blob is being created within the code. * Static Classes All classes are now static. * Pair programming comments
* .NET smoke Test Sample Performs functionalities with Key Vault, Identity, Event Hubs and Blob Storage Track 2 SDKs. * Env Variables names changed The names were changed to match the name convention for environment variables. * Update .gitignore * gitignore updated A gitignore file was created in the SmokeTest folder, and now all launchSettings.json files are being ignored. * Exit Codes, PascalCase and refactoring of the static methods. Work based on the reviews from the PR #6652. The public methods are now in PascalCase, the methods does not longer return English strings, instead they return booleans or Exceptions. And Exit Codes handling was implemented. * Class names changed Class names were changed to match the following pattern: <service>Test. Example: BlobStorage -> BlobStorageTest. * Comments XML comments were added and some unnecesary comments were deleted. * Higher order functions Use of higher order functions to dry up the code. * Test classes refactured Drying up the code by using high order functions. * Create CosmosDBTest.cs * Cosmos DB implementation Tests done with Mirosoft.Azure.DocumentDB SDK. * Update CosmosDBTest.cs * Update CosmosDBTest.cs * Unnecessary blank lines removed * ExecuteTest typo * Base class deleted The samples not longer need the "TestBase" class to run. * BlobTestSource.tst deleted This text file is not going to be needed any more since the test Blob is being created within the code. * Static Classes All classes are now static. * Pair programming comments * Concurrency support * License headers added * License header added * Adapted for concurrency * Use of string interpolation * Use of string interpolation * Update EventHubsTest.cs
* .NET smoke Test Sample Performs functionalities with Key Vault, Identity, Event Hubs and Blob Storage Track 2 SDKs. * Env Variables names changed The names were changed to match the name convention for environment variables. * Update .gitignore * gitignore updated A gitignore file was created in the SmokeTest folder, and now all launchSettings.json files are being ignored. * Exit Codes, PascalCase and refactoring of the static methods. Work based on the reviews from the PR Azure#6652. The public methods are now in PascalCase, the methods does not longer return English strings, instead they return booleans or Exceptions. And Exit Codes handling was implemented. * Class names changed Class names were changed to match the following pattern: <service>Test. Example: BlobStorage -> BlobStorageTest. * Comments XML comments were added and some unnecesary comments were deleted. * Higher order functions Use of higher order functions to dry up the code. * Test classes refactured Drying up the code by using high order functions. * Create CosmosDBTest.cs * Cosmos DB implementation Tests done with Mirosoft.Azure.DocumentDB SDK. * Update CosmosDBTest.cs * Update CosmosDBTest.cs * Unnecessary blank lines removed * ExecuteTest typo * Base class deleted The samples not longer need the "TestBase" class to run. * BlobTestSource.tst deleted This text file is not going to be needed any more since the test Blob is being created within the code. * Static Classes All classes are now static. * Pair programming comments * Concurrency support * License headers added * License header added * Adapted for concurrency * Use of string interpolation * Use of string interpolation * Update EventHubsTest.cs
Performs functionalities with Key Vault, Identity, Event Hubs and Blob Storage Track 2 SDKs.